DescribePropertyPortDetail

Description

call the DescribePropertyPortDetail interface to query the details of a port in the port list.

Request Method

POST

Request Path

/apsara/route/Sas/DescribePropertyPortDetail

Request Parameters Common Parameters

Name	Location	Type	Required	Sample value	Description
Uuid	BODY	string	No	50d213b4-3a35-427a-b8a5-***	unique identification ID of the asset instance.
PageSize	BODY	integer	No	6	The maximum number of pieces of data per page displayed during a paged query.
CurrentPage	BODY	integer	No	1	the page number of the current page displayed when paging query.
regionId	BODY	string	Yes	No sample value for this parameter.	region id
Port	BODY	string	No	22	port information.
ProcName	BODY	string	No	sshd	process name.
version	BODY	string	No	2016-01-01	version of api
Remark	BODY	string	No	1.2.3.4	server name or IP.

Return data

Name	Type	Sample value	Description
Propertys	array	No sample value for this parameter.	port information.
RequestId	string	FAA793EF-5B14-4CDD-B3E0-B14D4342C422	request ID of the result.
PageSize	integer	5	The maximum number of pieces of data per page displayed during a paged query.
InstanceId	string	50d213b4-3a35-427a-b8a5-04b0c7e1f4d2	ID of the asset associated with the port.
Port	string	22	port value.
Ip	string	1.2.3.1	assets correspond to public IP addresses.
ProcName	string	sshd	the name of the process corresponding to the port.
Count	integer	5	the number of data on the current page displayed during paging query.
IntranetIp	string	1.2.3.2	the asset corresponds to the private IP address.
InstanceName	string	test-***	name of the asset associated with the port.
PageInfo	struct	No sample value for this parameter.	page displays information.
TotalCount	integer	762	the total number of data.
Uuid	string	50d213b4-3a35-427a-b8a5-04b0c7e1f4d2	unique identification ID of the asset instance associated with the port.
Proto	string	tcp	port corresponds to network protocol.
InternetIp	string	1.2.3.1	assets correspond to public IP addresses.
CurrentPage	integer	1	the page number of the current page displayed when paging query.
Create	string	2019-05-13T10:39Z	the latest data collection time.
CreateTimestamp	long	1557715141000	the latest data collection timestamp.
BindIp	string	1.2.3.4	IP address information for port binding.

Example

Successful Response example

{
 "Propertys":"",
 "RequestId":"FAA793EF-5B14-4CDD-B3E0-B14D4342C422",
 "PageSize":"5",
 "InstanceId":"50d213b4-3a35-427a-b8a5-04b0c7e1f4d2",
 "Port":"22",
 "Ip":"1.2.3.1",
 "ProcName":"sshd",
 "Count":"5",
 "IntranetIp":"1.2.3.2",
 "InstanceName":"test-***",
 "PageInfo":"",
 "TotalCount":"762",
 "Uuid":"50d213b4-3a35-427a-b8a5-04b0c7e1f4d2",
 "Proto":"tcp",
 "InternetIp":"1.2.3.1",
 "CurrentPage":"1",
 "Create":"2019-05-13T10:39Z",
 "CreateTimestamp":"1557715141000",
 "BindIp":"1.2.3.4"
}

Failed Response example

{
 "errorSample":
 {
  "resultCode":-1,
  "resultMsg":"system error",
  "result":null
 }

}

---

title: DescribePropertyPortItem

sidebar_position: 3

DescribePropertyPortItem

Description

call DescribePropertyPortItem interface to obtain all port information.

Request Method

POST

Request Path

/apsara/route/aegis/DescribePropertyPortItem

Request Parameters Common Parameters

Name	Location	Type	Required	Sample value	Description
PageSize	BODY	integer	No	5	The maximum number of pieces of data per page displayed during a paged query.
CurrentPage	BODY	integer	No	1	the page number of the current page displayed when paging query.
regionId	BODY	string	Yes	No sample value for this parameter.	region id
Port	BODY	string	No	22	port number.
version	BODY	string	No	2016-01-01	version of api
ForceFlush	BODY	boolean	No	true	whether to force refresh the data to be queried.

Return data

Name	Type	Sample value	Description
PageInfo	struct	No sample value for this parameter.	page displays information.
TotalCount	integer	163	the total number of data.
RequestId	string	7E0618A9-D5EF-4220-9471-C42B5E92719F	request ID of the result.
Proto	string	tcp	the network protocol corresponding to the port.
PageSize	integer	5	The maximum number of pieces of data per page displayed during a paged query.
CurrentPage	integer	1	the page number of the current page displayed when paging query.
Port	string	22	listening port number.
Count	integer	5	the number of data on the current page displayed during paging query.
PropertyItems	array	No sample value for this parameter.	port information.

Example

Successful Response example

{
 "PageInfo":"",
 "TotalCount":"163",
 "RequestId":"7E0618A9-D5EF-4220-9471-C42B5E92719F",
 "Proto":"tcp",
 "PageSize":"5",
 "CurrentPage":"1",
 "Port":"22",
 "Count":"5",
 "PropertyItems":""
}

Failed Response example

{
 "errorSample":
 {
  "resultCode":-1,
  "resultMsg":"system error",
  "result":null
 }

}

---

title: DescribePropertyProcDetail

sidebar_position: 3

DescribePropertyProcDetail

Description

call the DescribePropertyProcDetail interface to get the details of a process in the process list.

Request Method

POST

Request Path

/apsara/route/aegis/DescribePropertyProcDetail

Request Parameters Common Parameters

Name	Location	Type	Required	Sample value	Description
User	BODY	string	No	root	the running user information of the process.
Uuid	BODY	string	No	c4678332-ef35-4ad4-***	unique identification ID of the process-associated asset instance.
PageSize	BODY	integer	No	5	The maximum number of pieces of data per page displayed during a paged query.
CurrentPage	BODY	integer	No	1	the page number of the current page displayed when paging query.
regionId	BODY	string	Yes	No sample value for this parameter.	region id
Cmdline	BODY	string	No	./8888	process startup parameters.
version	BODY	string	No	2016-01-01	version of api
Name	BODY	string	No	8888	process name.
Remark	BODY	string	No	1.2.3.4	server name or IP.

Return data

Name	Type	Sample value	Description
Path	string	/root/Oracle/Middleware/***/8888	path where the process is located.
Propertys	array	No sample value for this parameter.	process information.
Pname	string	start***.s	the name of the parent process to which the process belongs.
User	string	root	the running user of the process.
PageSize	integer	5	The maximum number of pieces of data per page displayed during a paged query.
RequestId	string	64388374-A309-4191-8606-3346CCA364B0	request ID of the result.
InstanceId	string	c4678332-ef35-4ad4-8358-***	the asset ID associated with the process.
StartTime	string	2019-08-07 10:09:05	process startup time.
Pid	string	12826	identity of running process
Count	integer	1	the number of data on the current page displayed during paging query.
EuidName	string	root	the running permission corresponding to the process.
IntranetIp	string	1.2.3.2	the asset corresponds to the private IP address.
Name	string	8888	process name.
InstanceName	string	test-***	the name of the asset associated with the process.
PageInfo		No sample value for this parameter.	page displays information.
TotalCount	integer	1	the total number of data.
Uuid	string	c4678332-ef35-4ad4-8358-6***	unique identification ID of the process-associated asset instance.
InternetIp	string	1.2.3.1	assets correspond to public IP addresses.
CurrentPage	integer	1	the page number of the current page displayed when paging query.
Create	string	2019-05-15T11:08Z	the latest data collection time.
Cmdline	string	./8888	The process corresponds to the startup parameter.
CreateTimestamp	long	1565686951000	the latest data collection timestamp.
Md5	string	N/A	file MD5 information corresponding to the process.

Example

Successful Response example

{
 "Path":"/root/Oracle/Middleware/***/8888",
 "Propertys":"",
 "Pname":"start***.s",
 "User":"root",
 "PageSize":"5",
 "RequestId":"64388374-A309-4191-8606-3346CCA364B0",
 "InstanceId":"c4678332-ef35-4ad4-8358-***",
 "StartTime":"2019-08-07 10:09:05",
 "Pid":"12826",
 "Count":"1",
 "EuidName":"root",
 "IntranetIp":"1.2.3.2",
 "Name":"8888",
 "InstanceName":"test-***",
 "PageInfo":"",
 "TotalCount":"1",
 "Uuid":"c4678332-ef35-4ad4-8358-6***",
 "InternetIp":"1.2.3.1",
 "CurrentPage":"1",
 "Create":"2019-05-15T11:08Z",
 "Cmdline":"./8888",
 "CreateTimestamp":"1565686951000",
 "Md5":"N/A"
}

Failed Response example

{
 "errorSample":
 {
  "resultCode":-1,
  "resultMsg":"system error",
  "result":null
 }

}